Repository navigation
docs: link each example file from the README - #122
Merged
Merged
Conversation
The README linked the examples only through the folder URL (/tree/main/...). https://github.com/robots.txt disallows /*/tree/ for Googlebot (User-agent: *) and for the AI crawlers, so search engines never read the folder listing. Each example file is now also linked by its /blob/ URL, which they may crawl. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues are reported for the README update that makes individual examples easier to find.
No open issues 🎉
What changed in this PR
Improves discoverability of the library’s examples by linking individual files directly from the README, avoiding reliance on the crawler-restricted GitHub folder listing.
Changes:
- Adds direct links and short descriptions for nine example files.
- Retains the examples folder link and omits the loader-only
examples/index.js. - Updates documentation only; no code changes.
| File | Description |
|---|---|
| README.md | Adds an annotated list of absolute links to individual examples. |
Review effort: Balanced
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README links the examples only through the folder URL (
/tree/main/examples). https://github.com/robots.txt disallows/*/tree/in theUser-agent: *group, which Googlebot follows, and in the group for GPTBot, OAI-SearchBot, ClaudeBot, anthropic-ai and PerplexityBot. Single-file/blob/URLs are allowed. So these crawlers never read the folder listing, and they only find an example file when some page links it directly.This PR keeps the folder link and adds a list under it: each example file, linked by its absolute
/blob/main/...URL, with a few words on what it does. Absolute URLs match the README's other links and also work where the README is shown outside GitHub.create_pdf_thumbnail.jsis included: since fd2449c it converts the first PDF page straight to JPG.examples/index.jsis left out because it only loads the other examples.🤖 Generated with Claude Code